Skip to content

chore: add issue/PR templates#1531

Merged
danielroe merged 8 commits intonpmx-dev:mainfrom
colinscz:chore/add-issue-templates
Feb 22, 2026
Merged

chore: add issue/PR templates#1531
danielroe merged 8 commits intonpmx-dev:mainfrom
colinscz:chore/add-issue-templates

Conversation

@colinscz
Copy link
Contributor

@colinscz colinscz commented Feb 16, 2026

🔗 Linked issue

Resolves #1522

📚 Description

This PR introduces a minimal template for pull requests, bug reports and feature requests. It also offers a link to the Npmx docs upon clicking the "create issue" button. Credit goes mainly to what is already there on the Nuxt project.

Looks similar to this (minus discussion and security vulnerability options)
image

Added a feature request template to streamline suggestions for feature requests.
@vercel
Copy link

vercel bot commented Feb 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs.npmx.dev Ready Ready Preview, Comment Feb 22, 2026 9:45am
npmx.dev Ready Ready Preview, Comment Feb 22, 2026 9:45am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
npmx-lunaria Ignored Ignored Feb 22, 2026 9:45am

Request Review

Added a section for additional context and tradeoffs.
@codecov
Copy link

codecov bot commented Feb 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@colinscz colinscz changed the title chore: add issue templates for bug reports and feature requests chore: add issue templates for bug reports and pull + feature requests Feb 16, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 16, 2026

📝 Walkthrough

Walkthrough

Adds standardized GitHub templates: .github/ISSUE_TEMPLATE/bug-report.yml (bug report form with a required description field, optional additional context and logs rendered as shell-script), .github/ISSUE_TEMPLATE/feature-request.yml (feature request form with labels, required feature description, optional contribution intent and checklist), .github/ISSUE_TEMPLATE/config.yml (issue template configuration permitting blank issues and providing a contact link), and .github/PULL_REQUEST_TEMPLATE.md (lightweight PR template with context, description, testing and checklist sections).

Suggested reviewers

  • danielroe
🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Out of Scope Changes check ❓ Inconclusive The PR includes bug report and feature request templates that were not explicitly requested in #1522, which only proposed a PR template. The config file with documentation link is a reasonable addition. Clarify whether bug report and feature request templates were intentional additions aligned with broader project templating goals or unplanned scope expansion beyond #1522.
✅ Passed checks (2 passed)
Check name Status Explanation
Description check ✅ Passed The PR description clearly relates to the changeset, describing the addition of templates for pull requests, bug reports, and feature requests, and references the linked issue.
Linked Issues check ✅ Passed The PR implements most requirements from #1522: PR template with context, changes, and testing instructions sections. However, it adds bug report and feature request templates beyond the linked issue scope.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

@danielroe danielroe changed the title chore: add issue templates for bug reports and pull + feature requests chore: add issue/PR templates Feb 22, 2026
Copy link
Member

@danielroe danielroe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 📚 npmx documentation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Capitalisation in name is inconsistent with the brand name used in about.

The name value uses all-lowercase npmx documentation, while the about field on line 5 correctly capitalises it as Npmx. The entry rendered in the issue chooser will display the name as-is, so contributors will see the inconsistency. Consider aligning to 📚 Npmx Documentation.

✏️ Proposed fix
-  - name: 📚 npmx documentation
+  - name: 📚 Npmx Documentation

Merged via the queue into npmx-dev:main with commit 617f695 Feb 22, 2026
17 checks passed
@colinscz colinscz deleted the chore/add-issue-templates branch February 22, 2026 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Proposal: Add a lightweight Pull Request template

2 participants